<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bluetooth Host Stack Library: MultiAdv</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Bluetooth Host Stack Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__btm__ble__multi__adv__functions.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">MultiAdv<div class="ingroups"><a class="el" href="group__wicedbt___legacy.html">LE Legacy Mode Advertising and Scanning</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>This section describes Multiple Advertisement API, using this interface application can enable more than one advertisement train. </p>
<dl class="section note"><dt>Note</dt><dd>Controller should have support for this feature. </dd></dl>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad7c886fa1ae0a32a7a80f42d5de7bac6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__btm__ble__multi__adv__functions.html#gad7c886fa1ae0a32a7a80f42d5de7bac6">wiced_start_multi_advertisements</a> (uint8_t advertising_enable, uint8_t adv_instance)</td></tr>
<tr class="memdesc:gad7c886fa1ae0a32a7a80f42d5de7bac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start/Stop Mulit advertisements.  <a href="#gad7c886fa1ae0a32a7a80f42d5de7bac6">More...</a><br /></td></tr>
<tr class="separator:gad7c886fa1ae0a32a7a80f42d5de7bac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d724a63eeff2bb4575e25c6484b1025"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__btm__ble__multi__adv__functions.html#ga4d724a63eeff2bb4575e25c6484b1025">wiced_set_multi_advertisement_data</a> (uint8_t *p_data, uint8_t data_len, uint8_t adv_instance)</td></tr>
<tr class="memdesc:ga4d724a63eeff2bb4575e25c6484b1025"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set multi advertisement data for each adv_instance.  <a href="#ga4d724a63eeff2bb4575e25c6484b1025">More...</a><br /></td></tr>
<tr class="separator:ga4d724a63eeff2bb4575e25c6484b1025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafcf665325c65c9b084e2ab788f8bbea4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__btm__ble__multi__adv__functions.html#gafcf665325c65c9b084e2ab788f8bbea4">wiced_set_multi_advertisement_params</a> (uint8_t adv_instance, <a class="el" href="structwiced__bt__ble__multi__adv__params__t.html">wiced_bt_ble_multi_adv_params_t</a> *params)</td></tr>
<tr class="memdesc:gafcf665325c65c9b084e2ab788f8bbea4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set multi advertisement params for each adv_instance.  <a href="#gafcf665325c65c9b084e2ab788f8bbea4">More...</a><br /></td></tr>
<tr class="separator:gafcf665325c65c9b084e2ab788f8bbea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaabb3afd4913a5d23eabbcece8ffc30e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__btm__ble__multi__adv__functions.html#gaabb3afd4913a5d23eabbcece8ffc30e9">wiced_set_multi_advertisement_scan_response_data</a> (uint8_t *p_data, uint8_t data_len, uint8_t adv_instance)</td></tr>
<tr class="memdesc:gaabb3afd4913a5d23eabbcece8ffc30e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set multi advertisement data for scan response.  <a href="#gaabb3afd4913a5d23eabbcece8ffc30e9">More...</a><br /></td></tr>
<tr class="separator:gaabb3afd4913a5d23eabbcece8ffc30e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf875d7862f1685f247d15f3bec49023a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__btm__ble__multi__adv__functions.html#gaf875d7862f1685f247d15f3bec49023a">wiced_set_multi_advertisements_random_address</a> (<a class="el" href="group__bt__types.html#gacf9a377aceca799be625c0dfe554902e">wiced_bt_device_address_t</a> randomAddr, uint8_t adv_instance)</td></tr>
<tr class="memdesc:gaf875d7862f1685f247d15f3bec49023a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set multi advertisement random address for an instance.  <a href="#gaf875d7862f1685f247d15f3bec49023a">More...</a><br /></td></tr>
<tr class="separator:gaf875d7862f1685f247d15f3bec49023a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga92b7ecffcb97b452d2ec815b15492235"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gentypes.html#ga2bc92bd117cfd3f6ec4ae452e6ced064">wiced_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__btm__ble__multi__adv__functions.html#ga92b7ecffcb97b452d2ec815b15492235">wiced_bt_notify_multi_advertisement_packet_transmissions</a> (uint8_t adv_instance, void(*clientCallback)(uint32_t), uint32_t advanceNoticeInMicroSeconds)</td></tr>
<tr class="memdesc:ga92b7ecffcb97b452d2ec815b15492235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows the application to register a callback that will be invoked just before an ADV packet is about to be sent out and immediately after.  <a href="#ga92b7ecffcb97b452d2ec815b15492235">More...</a><br /></td></tr>
<tr class="separator:ga92b7ecffcb97b452d2ec815b15492235"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad7c886fa1ae0a32a7a80f42d5de7bac6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad7c886fa1ae0a32a7a80f42d5de7bac6">&#9670;&nbsp;</a></span>wiced_start_multi_advertisements()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a> wiced_start_multi_advertisements </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>advertising_enable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>adv_instance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start/Stop Mulit advertisements. </p>
<p>wiced_start_multi_advertisements gives option to start multiple adverstisment instances Each of the instances can set different <a class="el" href="group__btm__ble__multi__adv__functions.html#gafcf665325c65c9b084e2ab788f8bbea4" title="Set multi advertisement params for each adv_instance.">wiced_set_multi_advertisement_params</a> and <a class="el" href="group__btm__ble__multi__adv__functions.html#ga4d724a63eeff2bb4575e25c6484b1025" title="Set multi advertisement data for each adv_instance.">wiced_set_multi_advertisement_data</a>. Hence this feature allows the device to advertise to multiple Centrals at the same time like a multiple peripheral device, with different advertising data, Random private addresses, tx_power etc.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">advertising_enable</td><td>: MULTI_ADVERT_START - Advertising is enabled MULTI_ADVERT_STOP - Advertising is disabled</td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">adv_instance</td><td>: 1 to MULTI_ADV_MAX_NUM_INSTANCES</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>wiced_bt_dev_status_t <pre class="fragment">             TRUE if command succeeded
</pre> </dd></dl>

</div>
</div>
<a id="ga4d724a63eeff2bb4575e25c6484b1025"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d724a63eeff2bb4575e25c6484b1025">&#9670;&nbsp;</a></span>wiced_set_multi_advertisement_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a> wiced_set_multi_advertisement_data </td>
          <td>(</td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>data_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>adv_instance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set multi advertisement data for each adv_instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_data</td><td>: Advertising Data ( Max length 31 bytess) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">data_len</td><td>: Advertising Data len ( Max 31 bytes ) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">adv_instance</td><td>: 1 to MULTI_ADV_MAX_NUM_INSTANCES</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>wiced_bt_dev_status_t <br />
 WICED_BT_SUCCESS if command succeeded </dd></dl>

</div>
</div>
<a id="gafcf665325c65c9b084e2ab788f8bbea4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafcf665325c65c9b084e2ab788f8bbea4">&#9670;&nbsp;</a></span>wiced_set_multi_advertisement_params()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a> wiced_set_multi_advertisement_params </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>adv_instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structwiced__bt__ble__multi__adv__params__t.html">wiced_bt_ble_multi_adv_params_t</a> *&#160;</td>
          <td class="paramname"><em>params</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set multi advertisement params for each adv_instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">adv_instance</td><td>: 1 to MULTI_ADV_MAX_NUM_INSTANCES </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>: Advertising params refer <a class="el" href="structwiced__bt__ble__multi__adv__params__t.html" title="LE Multi advertising parameter.">wiced_bt_ble_multi_adv_params_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>wiced_bt_dev_status_t <br />
 WICED_BT_SUCCESS if command succeeded </dd></dl>

</div>
</div>
<a id="gaabb3afd4913a5d23eabbcece8ffc30e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaabb3afd4913a5d23eabbcece8ffc30e9">&#9670;&nbsp;</a></span>wiced_set_multi_advertisement_scan_response_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a> wiced_set_multi_advertisement_scan_response_data </td>
          <td>(</td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>data_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>adv_instance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set multi advertisement data for scan response. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_data</td><td>: Advertising Data ( Max length 31 bytess) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">data_len</td><td>: Advertising Data len ( Max 31 bytes ) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">adv_instance</td><td>: 1 to MULTI_ADV_MAX_NUM_INSTANCES</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>wiced_bt_dev_status_t <br />
 WICED_BT_SUCCESS if command succeeded </dd></dl>

</div>
</div>
<a id="gaf875d7862f1685f247d15f3bec49023a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf875d7862f1685f247d15f3bec49023a">&#9670;&nbsp;</a></span>wiced_set_multi_advertisements_random_address()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group___result.html#gacfc32ead8a827d53416f01b19eb58310">wiced_bt_dev_status_t</a> wiced_set_multi_advertisements_random_address </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__bt__types.html#gacf9a377aceca799be625c0dfe554902e">wiced_bt_device_address_t</a>&#160;</td>
          <td class="paramname"><em>randomAddr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>adv_instance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set multi advertisement random address for an instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">randomAddr</td><td>: own random address </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">adv_instance</td><td>: 1 to MULTI_ADV_MAX_NUM_INSTANCES</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>wiced_bt_dev_status_t <br />
 WICED_BT_SUCCESS if command succeeded </dd></dl>

</div>
</div>
<a id="ga92b7ecffcb97b452d2ec815b15492235"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga92b7ecffcb97b452d2ec815b15492235">&#9670;&nbsp;</a></span>wiced_bt_notify_multi_advertisement_packet_transmissions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__gentypes.html#ga2bc92bd117cfd3f6ec4ae452e6ced064">wiced_bool_t</a> wiced_bt_notify_multi_advertisement_packet_transmissions </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>adv_instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void(*)(uint32_t)&#160;</td>
          <td class="paramname"><em>clientCallback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>advanceNoticeInMicroSeconds</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allows the application to register a callback that will be invoked just before an ADV packet is about to be sent out and immediately after. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">adv_instance</td><td>: 1 to MULTI_ADV_MAX_NUM_INSTANCES </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">clientCallback</td><td>: Pointer to a function that will be invoked in application thread context with WICED_BT_ADV_NOTIFICATION_READY for before ADV and WICED_BT_ADV_NOTIFICATION_DONE after ADV packet is complete. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">advanceNoticeInMicroSeconds</td><td>: Number of microseconds before the ADV the notification is to be sent. Will be rounded down to the nearest 1.25mS. Has to be an even multiple of 625uS.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>wiced_bool_t <br />
 WICED_TRUE if command succeeded </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Bluetooth Host Stack Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
